/*
 * fwnode.h - Firmware device node object handle type definition.
 *
 * Copyright (C) 2015, Intel Corporation
 * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
#ifndef SEMINIX_FWNODE_H
#define SEMINIX_FWNODE_H

#include <seminix/types.h>

struct fwnode_operations;
struct device_node;
struct of_device_id;

struct fwnode_handle {
    struct fwnode_handle *secondary;
    const struct fwnode_operations *ops;
};

/**
 * struct fwnode_endpoint - Fwnode graph endpoint
 * @port: Port number
 * @id: Endpoint id
 * @local_fwnode: reference to the related fwnode
 */
struct fwnode_endpoint {
    unsigned int port;
    unsigned int id;
    const struct fwnode_handle *local_fwnode;
};

#define NR_FWNODE_REFERENCE_ARGS	8

/**
 * struct fwnode_reference_args - Fwnode reference with additional arguments
 * @fwnode:- A reference to the base fwnode
 * @nargs: Number of elements in @args array
 * @args: Integer arguments on the fwnode
 */
struct fwnode_reference_args {
    struct fwnode_handle *fwnode;
    unsigned int nargs;
    u64 args[NR_FWNODE_REFERENCE_ARGS];
};

/**
 * struct fwnode_operations - Operations for fwnode interface
 * @get: Get a reference to an fwnode.
 * @put: Put a reference to an fwnode.
 * @device_get_match_data: Return the device driver match data.
 * @property_present: Return true if a property is present.
 * @property_read_integer_array: Read an array of integer properties. Return
 *				 zero on success, a negative error code
 *				 otherwise.
 * @property_read_string_array: Read an array of string properties. Return zero
 *				on success, a negative error code otherwise.
 * @get_parent: Return the parent of an fwnode.
 * @get_next_child_node: Return the next child node in an iteration.
 * @get_named_child_node: Return a child node with a given name.
 * @get_reference_args: Return a reference pointed to by a property, with args
 * @graph_get_next_endpoint: Return an endpoint node in an iteration.
 * @graph_get_remote_endpoint: Return the remote endpoint node of a local
 *			       endpoint node.
 * @graph_get_port_parent: Return the parent node of a port node.
 * @graph_parse_endpoint: Parse endpoint for port and endpoint id.
 */
struct fwnode_operations {
    struct fwnode_handle *(*get)(struct fwnode_handle *fwnode);
    void (*put)(struct fwnode_handle *fwnode);
    bool (*device_is_available)(const struct fwnode_handle *fwnode);
    const void *(*device_get_match_data)(const struct fwnode_handle *fwnode,
                const struct of_device_id *match, const struct device_node *node);
    bool (*property_present)(const struct fwnode_handle *fwnode,
                 const char *propname);
    int (*property_read_int_array)(const struct fwnode_handle *fwnode,
                       const char *propname,
                       unsigned int elem_size, void *val,
                       usize nval);
    int
    (*property_read_string_array)(const struct fwnode_handle *fwnode_handle,
                      const char *propname, const char **val,
                      usize nval);
    struct fwnode_handle *(*get_parent)(const struct fwnode_handle *fwnode);
    struct fwnode_handle *
    (*get_next_child_node)(const struct fwnode_handle *fwnode,
                   struct fwnode_handle *child);
    struct fwnode_handle *
    (*get_named_child_node)(const struct fwnode_handle *fwnode,
                const char *name);
    int (*get_reference_args)(const struct fwnode_handle *fwnode,
                  const char *prop, const char *nargs_prop,
                  unsigned int nargs, unsigned int index,
                  struct fwnode_reference_args *args);
    struct fwnode_handle *
    (*graph_get_next_endpoint)(const struct fwnode_handle *fwnode,
                   struct fwnode_handle *prev);
    struct fwnode_handle *
    (*graph_get_remote_endpoint)(const struct fwnode_handle *fwnode);
    struct fwnode_handle *
    (*graph_get_port_parent)(struct fwnode_handle *fwnode);
    int (*graph_parse_endpoint)(const struct fwnode_handle *fwnode,
                    struct fwnode_endpoint *endpoint);
};

#define fwnode_has_op(fwnode, op)				\
    ((fwnode) && (fwnode)->ops && (fwnode)->ops->op)
#define fwnode_call_int_op(fwnode, op, ...)				\
    (fwnode ? (fwnode_has_op(fwnode, op) ?				\
           (fwnode)->ops->op(fwnode, ## __VA_ARGS__) : -ENXIO) : \
     -EINVAL)
#define fwnode_call_bool_op(fwnode, op, ...)				\
    (fwnode ? (fwnode_has_op(fwnode, op) ?				\
           (fwnode)->ops->op(fwnode, ## __VA_ARGS__) : false) : \
     false)
#define fwnode_call_ptr_op(fwnode, op, ...)		\
    (fwnode_has_op(fwnode, op) ?			\
     (fwnode)->ops->op(fwnode, ## __VA_ARGS__) : NULL)
#define fwnode_call_void_op(fwnode, op, ...)				\
    do {								\
        if (fwnode_has_op(fwnode, op))				\
            (fwnode)->ops->op(fwnode, ## __VA_ARGS__);	\
    } while (false)

#endif /* !SEMINIX_FWNODE_H */
